home *** CD-ROM | disk | FTP | other *** search
/ Aminet 21 / Aminet 21 (1997)(GTI - Schatztruhe)[!][Oct 1997].iso / Aminet / text / edit / Smartindent.readme < prev    next >
Text File  |  1997-09-05  |  7KB  |  185 lines
  1. Short:    GoldED4 online code indention V37.5
  2. Author:   mshopf@informatik.uni-erlangen.de (Matthias Hopf)
  3. Uploader: mshopf@informatik.uni-erlangen.de (Matthias Hopf)
  4. Version:  37.5 beta
  5. Type:     text/edit
  6.  
  7. COPYIGHT
  8.  
  9.   ©1997 Matthias Hopf. All rights reserved.
  10.  
  11.   Some routines are based partially on the public domain CLib package from
  12.   Andreas R. Kleinert. Thanx!
  13.  
  14.  
  15. DISTRIBUTION
  16.  
  17.   This package is distributed as FreeWare under the GNU license.
  18.  
  19.  
  20. DESCRIPTION
  21.  
  22.   This is an API client for GoldED 4 that will scan all entered text and
  23.   indent it according to its built-in rules. The scanner is quite versatile
  24.   and will also report several types of syntax errors.
  25.  
  26.   Scanning will be done automatically when you press keys that could have
  27.   implications on the indentation of the current line. There is a new
  28.   ARexx command 'SMARTINDENT', too, with which you can explicitely start
  29.   the intendation process.
  30.  
  31.   By default the installation script will map for the C-source filetype TAB
  32.   to 'SMARTINDENT LINE', alt-TAB to 'SMARTINDENT BLOCK', shift-TAB and
  33.   ctrl-TAB to 'TAB' and shift-ctrl-TAB to 'BACKTAB', so you don't lose the
  34.   tabulator availability.
  35.  
  36.   Source code is provided and almost cleaned up. I would love to add more
  37.   indentation semantic parsers for other languages :^)
  38.  
  39.   Currently known indention modes:
  40.     C   (no more at the moment)
  41.  
  42.   ToDo: Still does some intentions not as I would like it to, but it's
  43.     getting better. Better documentation needed. Configuration GUI
  44.     (showing indentation of example source) needed.
  45.  
  46.  
  47. INSTALLATION
  48.  
  49.   Doubleclick at the installer script icon. It assumes that you already
  50.   have the envCPP filetype package installed.
  51.  
  52.  
  53. SYNTAX:
  54.  
  55.   API startup arguments:
  56.  
  57.     Template: MODE/K,DEBUG/N/K,CONFIG/M/N/K
  58.  
  59.       MODE:   Indention mode. When this argument is not specified or the
  60.           given mode is unknown, a list of all known indention modes
  61.           is shown in a requester.
  62.  
  63.       DEBUG:  One nummeric argument that specifies the debug level
  64.           (see util.h for more information)
  65.  
  66.       CONFIG: Currently 7 (or less) integer values that specify
  67.           (in this order):
  68.  
  69.       if (x)
  70.       ....x = x+1;         - Block indentation level   (default: 4)
  71.       switch (x)
  72.       ..{                  - Brace indentation level   (default: 0, here: 2)
  73.       x = x + 1;
  74. <-      case 1:            - Label indentation level   (default -2)
  75.       long int
  76.       ..value;         - Continued statement level (default 2)
  77.       value =
  78.          .0;       - Continued equation level  (default 1)
  79.  
  80.       ..../* xx */     - Standard comment level    (default 4)
  81.  
  82.       x=0;..../* x */  - (Absolute) in-line comment level (default 40)
  83.  
  84.  
  85.   'SMARTINDENT' command arguments:
  86.  
  87.     Template: LINE/S,CURSOR/S,BLOCK/S
  88.  
  89.       LINE:      Indent current line
  90.       CURSOR:    Move cursor to last indetation position in this line
  91.       BLOCK:     Indent marked block
  92.  
  93.  
  94. BUGS
  95.  
  96.   Yes, there are some bugs left, but only according to wrong indented
  97.   lines. So far smartindent V37.5 has not crashed my Amiga at all.
  98.   Read the comment at the beginning of test_input.c and test_correct.c for
  99.   more details.
  100.  
  101.  
  102. HISTORY
  103.  
  104.   V37.5 beta
  105.     - Some more indention bug fixes.
  106.     - Bug fix in endless loop detection.
  107.     - Indenting code less often on pressing '/' or '*' now
  108.       (only when necessary for comment indention).
  109.     - Finally implemented routine dispatcher needed for multiple
  110.       indention modes.
  111.  
  112.   V37.4 beta
  113.     - Some indention bug fixes. Should recognize all C++ words now.
  114.  
  115.   V37.3 beta
  116.     - Loads of bug fixes, one even potentially harmfull
  117.     - 'test' smakefile target and test_input.c testing source file for
  118.       checking indention abilities.
  119.  
  120.   V37.2 beta2
  121.     - Version information bug fixed. Installer should install the
  122.       API-client correctly now.
  123.     - Installer script reworked.
  124.     - New regedit for installation process provided. Thanx Dietmar!
  125.  
  126.   V37.2 beta
  127.     - First release.
  128.  
  129.  
  130. ============================= Archive contents =============================
  131.  
  132. Original  Packed Ratio    Date     Time    Name
  133. -------- ------- ----- --------- --------  -------------
  134.     1233     595 51.7% 06-Aug-97 01:09:08  Smartindent.info
  135.    23180   11014 52.4% 06-Aug-97 01:09:26 +smartindent.api
  136.    25204   13517 46.3% 06-Aug-97 01:09:14 +regedit
  137.    17996    7017 61.0% 06-Aug-97 01:09:14 +COPYING
  138.      856     436 49.0% 06-Aug-97 01:09:08 +COPYING.info
  139.     3348    1254 62.5% 06-Aug-97 01:09:14 +Install
  140.     1608    1227 23.6% 06-Aug-97 01:09:08 +Install.info
  141.      507     256 49.5% 06-Aug-97 01:09:14 +Install_d.bat
  142.      507     256 49.5% 06-Aug-97 01:09:14 +Install_e.bat
  143.       97      78 19.5% 06-Aug-97 01:09:08 +c.api
  144.       64      64  0.0% 06-Aug-97 01:09:08 +c.indent
  145.      581     213 63.3% 06-Aug-97 01:09:08 +c.keyboard
  146.     1527     383 74.9% 06-Aug-97 01:09:10 +c.mouse
  147.     1501     369 75.4% 06-Aug-97 01:09:10 +c.mouse
  148.     3880    1883 51.4% 06-Aug-97 01:09:14 +Smartindent.readme
  149.      856     440 48.5% 06-Aug-97 01:09:08 +Smartindent.readme.info
  150.     1233     594 51.8% 06-Aug-97 01:09:08 +Source.info
  151.     3811    1234 67.6% 06-Aug-97 01:09:12 +compiler.h
  152.      856     493 42.4% 06-Aug-97 01:09:12 +compiler.h.info
  153.     6258    2240 64.2% 06-Aug-97 01:09:10 +dispatcher.c
  154.      856     493 42.4% 06-Aug-97 01:09:12 +dispatcher.c.info
  155.      835     352 57.8% 06-Aug-97 01:09:10 +dispatcher.h
  156.      856     493 42.4% 06-Aug-97 01:09:12 +dispatcher.h.info
  157.     3653    1439 60.6% 06-Aug-97 01:09:10 +LibFuncs.c
  158.      856     493 42.4% 06-Aug-97 01:09:12 +LibFuncs.c.info
  159.     1004     341 66.0% 06-Aug-97 01:09:10 +LibFuncs.h
  160.      856     493 42.4% 06-Aug-97 01:09:12 +LibFuncs.h.info
  161.     3823    1333 65.1% 06-Aug-97 01:09:10 +LibInit.c
  162.      856     493 42.4% 06-Aug-97 01:09:12 +LibInit.c.info
  163.      266     170 36.0% 06-Aug-97 01:09:12 +SCOPTIONS
  164.      856     440 48.5% 06-Aug-97 01:09:12 +SCOPTIONS.info
  165.     3847    1433 62.7% 06-Aug-97 01:09:10 +semantics.h
  166.      856     493 42.4% 06-Aug-97 01:09:12 +semantics.h.info
  167.    20700    4587 77.8% 06-Aug-97 01:09:10 +semantics_c.c
  168.      856     493 42.4% 06-Aug-97 01:09:12 +semantics_c.c.info
  169.     2459     870 64.6% 06-Aug-97 01:09:12 +smakefile
  170.      856     440 48.5% 06-Aug-97 01:09:12 +smakefile.info
  171.     3529    1374 61.0% 06-Aug-97 01:09:10 +smartindent.h
  172.      856     493 42.4% 06-Aug-97 01:09:12 +smartindent.h.info
  173.     5085    1477 70.9% 06-Aug-97 01:09:10 +StartUp.c
  174.      856     493 42.4% 06-Aug-97 01:09:12 +StartUp.c.info
  175.     5996    1994 66.7% 06-Aug-97 01:09:10 +test_correct.c
  176.      856     493 42.4% 06-Aug-97 01:09:12 +test_correct.c.info
  177.     5228    1968 62.3% 06-Aug-97 01:09:10 +test_input.c
  178.      856     493 42.4% 06-Aug-97 01:09:12 +test_input.c.info
  179.    11854    3848 67.5% 06-Aug-97 01:09:10 +util.c
  180.      856     493 42.4% 06-Aug-97 01:09:12 +util.c.info
  181.     3681    1625 55.8% 06-Aug-97 01:09:10 +util.h
  182.      856     493 42.4% 06-Aug-97 01:09:12 +util.h.info
  183. -------- ------- ----- --------- --------
  184.   179903   73663 59.0% 07-Aug-97 08:42:10   49 files
  185.